org.springframework.test.context

Class MergedContextConfiguration

java.lang.Object

org.springframework.test.context.MergedContextConfiguration

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

WebMergedContextConfiguration

public class MergedContextConfiguration
extends java.lang.Object
implements java.io.Serializable

MergedContextConfiguration encapsulates the merged context configuration declared on a test class and all of its superclasses via @ContextConfiguration and @ActiveProfiles.

Merged resource locations, annotated classes, and active profiles represent all declared values in the test class hierarchy taking into consideration the semantics of the inheritLocations and inheritProfiles flags in @ContextConfiguration and @ActiveProfiles, respectively.

A SmartContextLoader uses MergedContextConfiguration to load an ApplicationContext.

MergedContextConfiguration is also used by the TestContext as the context cache key for caching an ApplicationContext that was loaded using properties of this MergedContextConfiguration.

Since:

3.1

Author:

Sam Brannen

See Also:

ContextConfiguration, ActiveProfiles, ContextConfigurationAttributes, SmartContextLoader.loadContext(MergedContextConfiguration), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	activeProfiles
private java.lang.Class<?>[]	classes
private java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>>	contextInitializerClasses
private ContextLoader	contextLoader
private static java.lang.Class<?>[]	EMPTY_CLASS_ARRAY
private static java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>>	EMPTY_INITIALIZER_CLASSES
private static java.lang.String[]	EMPTY_STRING_ARRAY
private java.lang.String[]	locations
private static long	serialVersionUID
private java.lang.Class<?>	testClass

Constructor Summary

Constructors

Constructor and Description
MergedContextConfiguration(java.lang.Class<?> testClass, java.lang.String[] locations, java.lang.Class<?>[] classes, java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> contextInitializerClasses, java.lang.String[] activeProfiles, ContextLoader contextLoader) Create a new MergedContextConfiguration instance for the supplied test class, resource locations, annotated classes, context initializers, active profiles, and ContextLoader.
MergedContextConfiguration(java.lang.Class<?> testClass, java.lang.String[] locations, java.lang.Class<?>[] classes, java.lang.String[] activeProfiles, ContextLoader contextLoader) Create a new MergedContextConfiguration instance for the supplied test class, resource locations, annotated classes, active profiles, and ContextLoader.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determine if the supplied object is equal to this MergedContextConfiguration instance by comparing both object's locations, annotated classes, context initializer classes, active profiles, and the fully qualified names of their ContextLoaders.
java.lang.String[]	getActiveProfiles() Get the merged active bean definition profiles for the test class.
java.lang.Class<?>[]	getClasses() Get the merged annotated classes for the test class.
java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>>	getContextInitializerClasses() Get the merged ApplicationContextInitializer classes for the test class.
ContextLoader	getContextLoader() Get the resolved ContextLoader for the test class.
java.lang.String[]	getLocations() Get the merged resource locations for the test class.
java.lang.Class<?>	getTestClass() Get the test class associated with this MergedContextConfiguration.
int	hashCode() Generate a unique hash code for all properties of this MergedContextConfiguration excluding the test class.
protected static java.lang.String	nullSafeToString(ContextLoader contextLoader) Generate a null-safe String representation of the supplied ContextLoader based solely on the fully qualified name of the loader or "null" if the supplied loaded is null.
private static java.lang.String[]	processActiveProfiles(java.lang.String[] activeProfiles)
private static java.lang.Class<?>[]	processClasses(java.lang.Class<?>[] classes)
private static java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>>	processContextInitializerClasses(java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> contextInitializerClasses)
private static java.lang.String[]	processLocations(java.lang.String[] locations)
java.lang.String	toString() Provide a String representation of the test class, locations, annotated classes, context initializer classes, active profiles, and the name of the ContextLoader.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

EMPTY_STRING_ARRAY

private static final java.lang.String[] EMPTY_STRING_ARRAY

EMPTY_CLASS_ARRAY

private static final java.lang.Class<?>[] EMPTY_CLASS_ARRAY

EMPTY_INITIALIZER_CLASSES

private static final java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> EMPTY_INITIALIZER_CLASSES

testClass

private final java.lang.Class<?> testClass

locations

private final java.lang.String[] locations

classes

private final java.lang.Class<?>[] classes

contextInitializerClasses

private final java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> contextInitializerClasses

activeProfiles

private final java.lang.String[] activeProfiles

contextLoader

private final ContextLoader contextLoader

Constructor Detail

MergedContextConfiguration

public MergedContextConfiguration(java.lang.Class<?> testClass,
                          java.lang.String[] locations,
                          java.lang.Class<?>[] classes,
                          java.lang.String[] activeProfiles,
                          ContextLoader contextLoader)

Create a new MergedContextConfiguration instance for the supplied test class, resource locations, annotated classes, active profiles, and ContextLoader.

If a null value is supplied for locations, classes, or activeProfiles an empty array will be stored instead. Furthermore, active profiles will be sorted, and duplicate profiles will be removed.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged resource locations

classes - the merged annotated classes

activeProfiles - the merged active bean definition profiles

contextLoader - the resolved ContextLoader

See Also:

MergedContextConfiguration(Class, String[], Class[], Set, String[], ContextLoader)

MergedContextConfiguration

public MergedContextConfiguration(java.lang.Class<?> testClass,
                          java.lang.String[] locations,
                          java.lang.Class<?>[] classes,
                          java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> contextInitializerClasses,
                          java.lang.String[] activeProfiles,
                          ContextLoader contextLoader)

Create a new MergedContextConfiguration instance for the supplied test class, resource locations, annotated classes, context initializers, active profiles, and ContextLoader.

If a null value is supplied for locations, classes, or activeProfiles an empty array will be stored instead. If a null value is supplied for the contextInitializerClasses an empty set will be stored instead. Furthermore, active profiles will be sorted, and duplicate profiles will be removed.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

contextLoader - the resolved ContextLoader

Method Detail

processLocations

private static java.lang.String[] processLocations(java.lang.String[] locations)

processClasses

private static java.lang.Class<?>[] processClasses(java.lang.Class<?>[] classes)

processContextInitializerClasses

private static java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> processContextInitializerClasses(java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> contextInitializerClasses)

processActiveProfiles

private static java.lang.String[] processActiveProfiles(java.lang.String[] activeProfiles)

nullSafeToString

protected static java.lang.String nullSafeToString(ContextLoader contextLoader)

Generate a null-safe String representation of the supplied ContextLoader based solely on the fully qualified name of the loader or "null" if the supplied loaded is null.

getTestClass

public java.lang.Class<?> getTestClass()

Get the test class associated with this MergedContextConfiguration.

getLocations

public java.lang.String[] getLocations()

Get the merged resource locations for the test class.

getClasses

public java.lang.Class<?>[] getClasses()

Get the merged annotated classes for the test class.

getContextInitializerClasses

public java.util.Set<java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>> getContextInitializerClasses()

Get the merged ApplicationContextInitializer classes for the test class.

getActiveProfiles

public java.lang.String[] getActiveProfiles()

Get the merged active bean definition profiles for the test class.

getContextLoader

public ContextLoader getContextLoader()

Get the resolved ContextLoader for the test class.

hashCode

public int hashCode()

Generate a unique hash code for all properties of this MergedContextConfiguration excluding the test class.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Determine if the supplied object is equal to this MergedContextConfiguration instance by comparing both object's locations, annotated classes, context initializer classes, active profiles, and the fully qualified names of their ContextLoaders.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Provide a String representation of the test class, locations, annotated classes, context initializer classes, active profiles, and the name of the ContextLoader.

Overrides:

toString in class java.lang.Object